﻿// 
// IProtocol.cs
//  
// Author:
//       Vladimir Aubrecht
// 
// Copyright (c) 2010 Tomas Vondracek
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;
using IM.DataTypes;

namespace IM.Interfaces.Protocols
{
    public enum ConnectionStates
    {
        Connected,
        Connecting,
        Authenticated,
        Authenticating,
        Disconnected
    }

    public delegate void ErrorHandler(object sender, Exception ex);
    public delegate void ObjectHandler(object sender);
    public delegate void UserHandler(User sender);
    public delegate void MessageHandler(object sender, User from, String body);
    public delegate void ContactListHandler(object sender, User[] onlineUsers);
    public delegate void ConnectionStateHandler(object sender, ConnectionStates state);

    public interface IProtocol
    {
        event ObjectHandler OnLogin;
        event ErrorHandler OnError;
        event MessageHandler OnMessage;
        event ObjectHandler OnClose;
        event ContactListHandler OnContactListLoad;
        event ConnectionStateHandler OnConnectionStateChanged;

        User[] Users { get; }
        User UserID { get; }
        String AccountName { get; set; }
        String ProtocolName { get; }
        bool Enabled { get; set; }

        void Login(string username, string password);
        void Logout();

        void SendMessage(string message, User username);

        Object GetSettingsData();
        void LoadSettingsData(Object obj);
    }
}
